@aws-sdk/types

What is @aws-sdk/types?

The @aws-sdk/types package provides TypeScript definitions for the AWS SDK for JavaScript v3. These types define the shapes of AWS service clients, commands, input and output parameters, and other utility types that are used across the AWS SDK. This package is essential for TypeScript developers using the AWS SDK as it enables type checking and IntelliSense support in IDEs.

What are @aws-sdk/types's main functionalities?

Service Client Interface

Defines the configuration interface for an AWS service client, such as the S3 client. It extends from a base client configuration and includes service-specific options.

{"interface S3ClientConfig extends SmithyClientConfig {endpoint?: HttpEndpoint, forcePathStyle?: boolean, useAccelerateEndpoint?: boolean, ...}}

Command Interface

Represents a command interface that defines input and output types for a specific operation. It also includes methods for resolving middleware in the command's execution stack.

{"interface Command<InputType extends object, OutputType extends object, ResolvedClientConfiguration, ClientInput extends InputType = InputType, ClientOutput extends OutputType = OutputType> {resolveMiddleware(stack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResolvedClientConfiguration): Handler<ClientInput, ClientOutput>; ...}}

Middleware Stack

Defines the middleware stack interface used in the AWS SDK. Middleware are functions that can modify requests and responses or handle specific tasks like logging or error handling.

{"interface MiddlewareStack<Input extends object, Output extends object> {add(middleware: MiddlewareType<Input, Output>, options?: MiddlewareStackOptions): void; addRelativeTo(middleware: MiddlewareType<Input, Output>, options: RelativeMiddlewareOptions): void; ...}}

Other packages similar to @aws-sdk/types

@google-cloud/common

Provides types and utility functions for Google Cloud client libraries for Node.js. Similar to @aws-sdk/types, it offers TypeScript definitions but for Google Cloud services.

azure-sdk-for-js

The Azure SDK for JavaScript provides TypeScript type definitions for Azure services. It is analogous to @aws-sdk/types but tailored for Microsoft Azure's cloud services.

@types/node

This package contains type definitions for Node.js. While not specific to a cloud provider, it serves a similar purpose by providing TypeScript types for Node.js core modules, much like @aws-sdk/types does for AWS SDK.

README

@aws-sdk/types

Changelog

3.696.0 (2024-11-19)

Features

• client-b2bi: Add new X12 transactions sets and versions (cb3d07b)
• client-ec2: This release adds VPC Block Public Access (VPC BPA), a new declarative control which blocks resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. (7905a8e)
• client-ecs: This release introduces support for configuring the version consistency feature for individual containers defined within a task definition. The configuration allows to specify whether ECS should resolve the container image tag specified in the container definition to an image digest. (d632c0c)
• client-efs: Add support for the new parameters in EFS replication APIs (1f77893)
• client-glue: AWS Glue Data Catalog now enhances managed table optimizations of Apache Iceberg tables that can be accessed only from a specific Amazon Virtual Private Cloud (VPC) environment. (844a1da)
• client-keyspaces: Amazon Keyspaces Multi-Region Replication: Adds support to add new regions to multi and single-region keyspaces. (9c30b3a)
• client-mwaa: Amazon MWAA now supports a new environment class, mw1.micro, ideal for workloads requiring fewer resources than mw1.small. This class supports a single instance of each Airflow component: Scheduler, Worker, and Webserver. (a64d4bb)
• client-taxsettings: Release Tax Inheritance APIs, Tax Exemption APIs, and functionality update for some existing Tax Registration APIs (da73fe5)
• client-workspaces: Releasing new ErrorCodes for Image Validation failure during CreateWorkspaceImage process (5649e47)
• clients: update client endpoints as of 2024-11-19 (3a63d0b)